home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / utility / 681 / insp_180 / insp_180.doc next >
Text File  |  1993-02-09  |  13KB  |  331 lines
  1.  
  2.  
  3.                               The Inspector
  4.  
  5.                               Version 1.80
  6.                 02/10/93
  7.                               
  8.                            Copyright 1992,1993
  9.                           
  10.                       Written by Daniel M. Wallin jr.
  11.                       
  12.                       
  13.                       
  14.  INTRODUCTION :
  15.         
  16.        The Inspector is a program designed to help diagnose
  17.        problems that may occur during the operation of your
  18.        computer.  The Inspector can be configured to generate
  19.        error reports which occur when the operating system
  20.        has encountered a problem.  Very often such problems
  21.        can cause a program to fail mysteriously, without
  22.        any indication of what really went wrong.  If a file
  23.        is being looked for and was not found, The Inspector
  24.        will display a report showing what was being looked
  25.        for, where it was expected to be, and the current
  26.        subdirectory.
  27.          
  28.        There are also options to generate reports continuously.  
  29.        This allows you to monitor the operating system when it is 
  30.        reading or writing files, or other disk operations.  A 
  31.        special feature useful for debugging is also included that 
  32.        causes the operating system to totally ignore any desktop
  33.        accessories.  This feature is global, meaning that
  34.        all desktop accessories are affected, and unlike
  35.        other utilities, the filename extensions of the
  36.        desktop accessories are not modified in any way.
  37.        This feature is VERY useful when a malfunctioning
  38.        desktop accessory on the hard drive is causing the
  39.        system to continously reboot, or when you need to load
  40.        the operating system with the most amount of memory
  41.        available.
  42.        
  43.  Program Requirements and Peculiarities :
  44.  
  45.        The program is known to work with the following
  46.        computers :
  47.  
  48.            520ST, 1040ST, 520STE, 1040STE, TT, STACEY.
  49.        
  50.        The program runs in LO or MEDIUM resolutions.
  51.        Other resolutions may work, but are not currently
  52.        supported.
  53.        
  54.        This program will not work concurrently with
  55.        Pathfinder.   Pathfinder must be disabled when
  56.        The Inspector is used.  Unlike Pathfinder, The
  57.        Inspector will reload into memory when the screen
  58.        resolution is changed.
  59.        
  60.        The Inspector does not work well with programs that
  61.        read or write directly from screen memory.  This does
  62.        not cause problems except with a very small number
  63.        of programs, and otherwise should never be a problem.
  64.        The symptoms of the problem are a blank spot in the
  65.        screen of the same size as the error report.
  66.        
  67.     
  68.  Getting Started :
  69.  
  70.         To use The Inspector, copy the INSP_180.PRG file into
  71.         your AUTO folder.  The next time the system is rebooted,
  72.         a message will appear for a few seconds indicating that 
  73.         The Inspector is waiting for a SPACE BAR to be pressed
  74.         to configure it's options.  If you do not press the
  75.         SPACE BAR before the time runs out, then the the program 
  76.         will automatically be installed using the defaults, or
  77.            whatever options have been previously saved.  If the
  78.            SPACE BAR was pressed, then a menu will appear showing
  79.            the current options.  Pressing F1 - F6 will change one
  80.            of the options, and pressing F10 will cause the current
  81.            options to be used, and continue with the initialization
  82.            of the operating system.  If the CONTROL key is depressed
  83.            instead of the SPACE BAR, then the operating system will
  84.            be loaded as normal, but The Inspector will be installed
  85.            with the current defaults, EXCEPT that the desktop
  86.            accessories will be disabled regardless of the setting
  87.            of the F6 option.  This was included to allow a quick
  88.            and easy way to boot the computer without the accessories
  89.            being loading into memory.
  90.  
  91.            
  92.  Options Summary :
  93.  
  94.         
  95.         F1 - Diagnostic Mode
  96.         F2 - Response Mode
  97.         F3 - Read Write Minimum
  98.         F4 - Lost Files
  99.         F5 - Lost Folders
  100.         F6 - Desk Accessories
  101.            F7 - Display Speed
  102.         F9 - Save Defaults
  103.        F10 - Exit
  104.         
  105.       
  106.        
  107.  F1 - DIAGNOSTIC MODE
  108.  
  109.           
  110.           The is the main option that will need to be set.  
  111.           Pressing the F1 key will cycle thru the following 
  112.           possible diagnostic modes :  
  113.           
  114.           FULL DIAGNOSTICS, ERRORS ONLY, INACTIVE.
  115.        
  116.        FULL DIAGNOSTICS will cause continuous reports to
  117.        be displayed EVERY time the operating system is used
  118.        to read, write, delete, create, or search for files,
  119.        even if no error has occured.  This option is very useful
  120.        for determining what files a program is using or looking
  121.        for.
  122.        
  123.        ERRORS ONLY will cause reports to be displayed only when
  124.        an error has occured.  This allows the operation of
  125.        The Inspector to be totally unnoticed until something
  126.        goes wrong.
  127.        
  128.        INACTIVE will cause the installation of The Inspector
  129.        to be cancelled.  Any memory allocated by the program
  130.        will be returned to the operating system.
  131.        
  132.        
  133.  F2 - RESPONSE MODE
  134.  
  135.  
  136.        This option determines what action the computer will take
  137.        after generating an error report.  Pressing F2 will
  138.        cycle thru the following possible options :
  139.        
  140.       WAIT FOR KEY, TIME DELAY, SLOW MOTION       
  141.  
  142.    (SLOW MOTION will only be available when FULL DIANOSTICS is enabled)
  143.  
  144.        WAIT FOR KEY will cause the computer to wait for a keypress
  145.        after every error report.  This will allow you to closely
  146.        examine what occured, such as why a program was unable
  147.        to find a file it was searching for.
  148.        
  149.        TIME DELAY will cause the computer to pause for
  150.        before erasing the error report.  The length of the
  151.        time delay is determined by option F7, the display
  152.        speed.  This option is useful for monitoring the a program 
  153.        when you know that it will attempt to load files that are
  154.        optional that will generate an missing file report,
  155.        or when the system is unattended as when a BBS is
  156.        running.
  157.        
  158.        SLOW MOTION will cause the computer to pause before
  159.        and after each call to the operating system.  The reason
  160.        this is called slow motion will become obvious as you
  161.        wait 10 minutes for a program that otherwise only takes
  162.        2 minutes to run.  This option is mainly useful for 
  163.        debugging programs that fail to work at all.
  164.  
  165.        
  166.  F3 - READ/WRITE MINIMUM
  167.  
  168.  
  169.           The READ/WRITE MINIMUM determines the threshold of
  170.           the amount of data read or written by the operating
  171.           system that will generate a report.  Pressing
  172.           F3 will cycle between ZERO and 1024 BYTES.  This
  173.           option is useful for programs that continuously 
  174.           write or read small amounts of data.  If a program
  175.           such as an assembler is used while full diagnostics
  176.           is enabled, and very small amounts of data are 
  177.           written continously, then a report will be generated
  178.           for every few bytes, and a noticeable decrease in
  179.           speed will occur.  With the minimum set to 1024 bytes,
  180.           no speed decrease will be noticed except perhaps on
  181.           the very fastest drives when full diagnostics mode
  182.           is enabled.
  183.           
  184.  F4 - LOST FILES
  185.  
  186.  
  187.           This option determines what action will be taken when
  188.           the operating system is asked for a file that cannot
  189.           be located.  Normally this would cause a program to
  190.           fail, and a report would be generated to show where
  191.           the file was being looked for.  However, if a program
  192.           is looking for an optional file, then a report would
  193.           be generated for every optional file that was not
  194.           located.  Pressing F4 will toggle between NORMAL
  195.           and IGNORE.  If IGNORE is selected, then no report
  196.           will be generated for any missing files.
  197.  
  198.           
  199.  F5 - LOST FOLDERS
  200.  
  201.  
  202.           This option is identical to LOST FILES, except that it
  203.           determines if an attempt by the operating system to
  204.           access a non-existant folder will generate an error
  205.           report.  Sometimes it is useful to IGNORE LOST FILES,
  206.           while generating reports for LOST FOLDERS or vice versa.
  207.           When running a BBS it is often useful to know what
  208.           files or folders are being searched, and F4 and F5
  209.           allow you to decide what errors will generate a report.                    
  210.  
  211.  F6 - DESK ACCESSORIES
  212.  
  213.  
  214.        This option can be used to cause the operating system to 
  215.        totally ignore any desk accessories.  Pressing F6 will
  216.        cycle between ON and IGNORE.  If IGNORE is selected,
  217.        then the dekstop accessories will not be loaded into
  218.        memory.  This option will affect ALL desktop accessories.
  219.        The benefit of this way of disabling the accessories is
  220.        two-fold.  It is quick and easy, and does not modify the
  221.        disk in any way unlike other utilities that simply rename
  222.        the extension from .ACC to .ACX or something similar.
  223.        NOTE : NEWDESK users will have to setup their desktop
  224.        after this option as the NEWDESK.INF file will not be
  225.        loaded without the XCONTROL.ACC being loaded into the
  226.        system.  The next time the system is booted with F6 OFF,
  227.        (and without pressing the CONTROL key), the desktop will
  228.        appear in it's previous configuration.
  229.      
  230.        
  231.  F7 - DISPLAY SPEED
  232.  
  233.  
  234.           This option allows you to fine tune the speed at which
  235.           reports will be displayed and erased.  Pressing F7 will
  236.           cycle thru 0.5, 2, and 4 seconds.  By adjusting the speed
  237.           of the display, you can either get a more readable report,
  238.           or a fast one... (useful for full diagnostics).
  239.           
  240.        
  241.  F9 - SAVE DEFAULTS
  242.  
  243.  
  244.           This option will save the current options into the program.
  245.           The program will be assumed to be in the AUTO folder of
  246.           the current drive.  The options will be saved INTO the
  247.           program itself, so no other options file is needed,
  248.           and any copy of the INSP_180.PRG file after saving the
  249.           defaults will contain the current options as the defaults.       
  250.        
  251.        
  252. F10 - EXIT
  253.  
  254.  
  255.           This option will cause an exit from the menu, and the
  256.           operating system will continue loading.  If the
  257.           diagnostics mode is set to inactive, then the
  258.           installation of The Inspector will be aborted, and
  259.           all memory reserved by the program will be returned
  260.           to the operating system.
  261.           
  262.           
  263.  IMPROVEMENTS OVER VERSION 1.75
  264.  
  265.        The Inspector now will ignore FORCE MEDIA CHANGE attempts
  266.        by the operating system that before would produce a report
  267.        showing a file such as 'X' or '\\X'.  Other programs may
  268.        use anything.  As long as a program uses a '*.*', a 'X'
  269.        or a '\\X' then it will be ignored by The Inspector as
  270.        it should be.  
  271.        
  272.        The Inspector now will not modify the cursor position.
  273.        In version 1.75, moving the mouse sometimes caused 
  274.        sections of the screen to be changed.  This problem
  275.        was fixed by disabling the mouse during calls operating 
  276.        system for disk operations.  
  277.        
  278.           
  279.       
  280. PROGRAM CREDITS :
  281.  
  282.     Written by Daniel M. Wallin jr.
  283.          
  284.     A special thanks to Martin Crommie, Sysop of Puddle City BBS,
  285.     for the use of his FOREM based BBS for testing purposes.
  286.                  
  287.     Version 1.80 of The Inspector is FREEWARE.  You can use, give,
  288.     or copy it as much as you like, as long as all docs are included
  289.     in an unmodified form.  This program may not be distrubted for
  290.     commercial purposes, or as part of any package that is being
  291.     sold without the written permission of the author.
  292.     
  293.  
  294. THE FUTURE OF THE INSPECTOR :
  295.     
  296.     
  297.     There are many additions currently being worked on, including
  298.     error logs, XBIOS error reports for the hard drive,
  299.     active virus guard routines (like in Pathfinder), the ability
  300.     to change options from within other programs, support for the
  301.     Falcon, and better cooperation with programs that read 
  302.     or write directly from screen memory, and some of the options
  303.     that are being considered.
  304.     
  305.     The expansion of this program will depend primarily upon user 
  306.     feedback.  If I get a lot of response about the usefulness of 
  307.     this program, then I will keep adding to it, and refining it, 
  308.     so please send any comments, suggestions, problems, questions
  309.     OR CONTRIBUTIONS.
  310.     
  311.     If you find this program useful, please send a contribution
  312.     to  :
  313.      
  314.      Daniel M. Wallin jr.
  315.      P.O. Box 5011
  316.      Aloha, OR 97006-0011
  317.      
  318.     Also check out PATHFINDER version 1.6, a MUST for every hard drive 
  319.     owner.
  320.     
  321.     Look for the most recent versions of The Inspector and Pathfinder
  322.     and other utilities by me on the following bulliten board systems :
  323.     (I can also be reached via EMAIL on Puddle City)
  324.     
  325.     BBS NAME                       Phone Number  Sysop
  326.     
  327.     Puddle City BBS                    503-289-9429  Martin Crommie 
  328.     ST Enthusiasts of Portland         503-297-6542  James Williams
  329.     Realm of the Alternate Eternities  503-649-7915  Max Denebian 
  330.     
  331.